feat: pin granting resources to top of API reference nav#1116
Open
sybohy wants to merge 1 commit into
Open
Conversation
31e78a9 to
19315bb
Compare
6fb0356 to
82be350
Compare
19315bb to
a754e08
Compare
82be350 to
f033228
Compare
5006075 to
23b9aa2
Compare
d8f2ac1 to
e7adb4b
Compare
23b9aa2 to
9a78cfb
Compare
d9aae83 to
1771492
Compare
133caf0 to
9aa6fc6
Compare
1771492 to
374b646
Compare
The API reference resource list was purely alphabetical, which put the legacy Access Codes and ACS resources first and buried Access Grants. Pin the recommended access-granting resources (access_grants, access_methods, spaces, user_identities, instant_keys) to the top and sink the low-level legacy granting resources (access_codes, acs) to the bottom. Everything else stays alphabetical in between. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
374b646 to
9aa06a3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Part 3 of the Access Grants front-door refactor (stacked on #1115 → #1114). The API reference nav was purely alphabetical, so the legacy Access Codes and ACS resources sat at the very top while Access Grants was buried mid-list — the opposite of the recommendation.
What
A top-level rank in
codegen/lib/layout/summary.ts:Generation stays fully automatic — no hand-edited generated files;
npm run generateoutput is deterministic. No URLs change (pure reorder).Validation
npm run generate→ onlydocs/api-reference/SUMMARY.mdchangedtypecheck/lint/validate-paths/validate-links✅Remaining (PR 4b, seam-connect)
Endpoint prose still says just "Creates a new Access Grant." and the access_codes/acs descriptions don't mention the recommendation — that text lives in seam-connect zod
.describe()strings and flows through@seamapi/types. Separate PR there.🤖 Generated with Claude Code